Update README for current CLI behavior and troubleshooting#35
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #35 +/- ##
=======================================
Coverage 89.94% 89.94%
=======================================
Files 8 8
Lines 368 368
=======================================
Hits 331 331
Misses 25 25
Partials 12 12 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates the
README.mdto clarify TagIt's functionality, provide more detailed usage instructions, and add new sections for configuration, development, and troubleshooting. The documentation now better explains how TagIt manages Consul service tags, how to configure it, and how to resolve common issues.Clarification of TagIt functionality:
tag-prefixand preserves non-prefixed tags, instead of simply appending script output.Expanded usage and examples:
Configuration details:
Configurationsection describing CLI flags, config file support, and environment variable binding, including an example YAML config.Development workflow:
Developmentsection with Makefile targets for building, testing, and running integration tests with Docker Compose.Troubleshooting guidance:
Troubleshootingsection covering common errors, systemd command requirements, quick checks for Consul and service status, and validation steps for cleanup.New table of contents entries:
Configuration,Development, andTroubleshootingsections.